List Report Rows
Returns published Replenishment Report rows for one warehouse specified by its id path parameter.
Each row snapshots the effective Replenishment Policy and Location Profile, the exact profile
revision used for aggregation, quantity/DOI/shortfall results, and the calculation time.
The response meta identifies the published generation and whether it satisfies the latest rebuild
request. Clients paging through a report should restart if published_generation changes between pages.
Each row’s computed_at is the per-product quantity-freshness contract.
A report screen can additionally request fields=policy,location_profile
with selected direct fields such as fields:policy=name,is_active and
fields:location_profile=name,status,member_count. The referenced objects
are then returned once through included; their own relationships remain
available from the owning Policy and Location Profile endpoints.
Paging with cursor_start or cursor_end requires the default id or -id sort: the cursor
is a range over the identifier, which the other sort orders do not follow. A listing under any
other sort therefore reports has_more without continuation links; to enumerate more than one
page, use the default id or -id sort.
Authorizations
Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.
Path Parameters
The id of the referenced Warehouse.
Query Parameters
Specify additional fields of the ReplenishmentReport object to be included in the response.
basic, all, product, policy, policy_id, policy_name, location_profile, location_profile_id, location_profile_name, profile_revision_id, group_qty, assigned_count, warehouse_qty, available_to_move, daily_demand, doi_days, trigger_doi_days, target_doi_days, shortfall_qty, is_flagged, presence, computed_at Specify additional common fields of the Product or stockable Packaging* object referenced by each Replenishment Report row. See the selecting fields page for more information.
Specify additional common fields of the Product or stockable Packaging*
object referenced by a Replenishment Report row.
basic, all, vendor_sku, manufacturer_part_number, external_id, barcodes, goods_type, is_available, is_visible, created_at, updated_at, weight, dimensions, volume, inventory, export, regulated_goods, packaging, custom_fields Specify additional fields of the Merchant object to be included in the response. See the selecting fields page for more information.
basic, all, code, name, status, created_at, updated_at, brands, default_brand, custom_fields Specify direct fields of the ReplenishmentPolicy referenced by each Report row.
Subject relationships, counters, and the Policy's own Location Profile expansion are
intentionally unavailable through this endpoint. See the
selecting fields page for more information.
Specify direct fields of the included ReplenishmentPolicy object.
name, is_active, sort_order, demand_period_days, trigger_doi_days, target_doi_days, qualification_reason, created_at, updated_at Specify direct summary fields of the LocationProfile referenced by each Report row.
Match definitions, usage details, and nested tag/type relationships are intentionally
unavailable through this endpoint. See the
selecting fields page for more information.
Specify direct summary fields of the included LocationProfile object.
name, description, status, member_count, created_at, updated_at Using the filtering syntax, you may filter the results using the following fields:
idskumerchant_idis_flaggedpresencepolicy_idlocation_profile_idprofile_revision_iddoi_daysshortfall_qtycomputed_at
The default sort order is ascending by primary key (sort=id). Every sort carries an ascending id tie-break, because none of the other sortable values are unique. sku ordering joins the Product catalog, so it is intended for filtered or bounded result sets.
The following fields are available for sorting:
idskudoi_daysshortfall_qtydaily_demandcomputed_at
If specified as 1, the meta.count property of the response will be present and populated with the total count of items
matching the query before any paging is applied. This is not included by default to improve performance in some edge
cases and is not required to perform paging using the next property of the response.
See paging parameters for more information.
0 <= x <= 1A cursor for use in pagination which defines the last id of the next page of results, non-inclusive.
See paging parameters for more information on paging.
A cursor for use in pagination which defines the starting id of the next page of results.
See paging parameters for more information on paging.
A limit on the number of objects to be returned.
1 <= x <= 1000100
Response
A dictionary with a collection property that contains a list of up to
limit ReplenishmentReport objects matching the query.
A list of ReplenishmentReport objects.
Lists of referenced objects included by specifying optional fields. See the selecting fields page for more information.
True if the collection has more items on the next page. Use the "next" link to retrieve the next page of results.
The resource path for the next page of results if any are expected.
The resource path for the previous page of results if any are expected.
Additional metadata pertaining to the response.